Interface AsaNetworkObject

All Superinterfaces:
IPCObject
All Known Implementing Classes:
AsaNetworkObjectImpl

public interface AsaNetworkObject extends IPCObject
Information provided by the PKI file:

    \class CAsaNetworkObject
    
    \brief CAsaNetworkObject is the asa network object
    \example network().getDevice("Router0").getObjectManager()->getObjectByName("objectName")
    \\use castTo() function to cast AsaObject to AsaNetworkObject
    
Author:
Auto-generated
  • Method Details

    • setHostIp

      void setHostIp(IPAddress hostIp)
      Information provided by the PKI file:
      
          \brief set the host ip address to the asa network object
          
          \param hostIp, ip address to use as the host.
          
              
      Parameters:
      hostIp - Takes in a parameter of hostIp
    • getHostIp

      IPAddress getHostIp()
      Information provided by the PKI file:
      
          \brief Returns the host ip address/network address that is set to the asa network object
          
          \return ip, value is the host ip address/network address that is set to the asa network object.
          
              
      Returns:
      IPAddress Returns a IPAddress
    • getHostMask

      IPAddress getHostMask()
      Information provided by the PKI file:
      
          \brief Returns the subnet mask that is set to the asa network object.
          
          \return ip, value is the the subnet mask that is set to the asa network object.
          
              
      Returns:
      IPAddress Returns a IPAddress
    • getInvHostMask

      IPAddress getInvHostMask()
      Information provided by the PKI file:
      
          \brief Returns the inverse subnet mask that is set to the asa network object.
          
          \return ip, value is the the inverse subnet mask that is set to the asa network object.
          
              
      Returns:
      IPAddress Returns a IPAddress
    • removeHostIp

      boolean removeHostIp(IPAddress hostIp)
      Information provided by the PKI file:
      
          \brief Remove the host ip address that is set to the asa network object
          
          \param hostIp, hos ip address to remove.
          
          \return bool, value is true if the host was removed, false if not.
          
              
      Parameters:
      hostIp - Takes in a parameter of hostIp
      Returns:
      boolean Returns a boolean
    • setSubnet

      void setSubnet(IPAddress hostIp, IPAddress hostMask)
      Information provided by the PKI file:
      
          \brief Set the subnet/mask to the asa network object
          
          \param hostIp, Host ip address to set with.
          \param hostMask, Host mask to set with.
          
              
      Parameters:
      hostIp - Takes in a parameter of hostIp
      hostMask - Takes in a parameter of hostMask
    • removeSubnet

      boolean removeSubnet(IPAddress hostIp, IPAddress hostMask)
      Information provided by the PKI file:
      
          \brief Remove the subnet/mask that is set to the asa network object
          
          \param hostIp, Host ip address to remove for.
          \param hostMask, Host mask to remove for.
          
          \return bool, return is true if the subnet was removed, false if not.
          
              
      Parameters:
      hostIp - Takes in a parameter of hostIp
      hostMask - Takes in a parameter of hostMask
      Returns:
      boolean Returns a boolean
    • getNatEntry

      NATEntry getNatEntry()
      Information provided by the PKI file:
      
          \brief Returns static nat entry that is set to the asa network object
          
          \return NatEntry, value is the static nat entry.
          
              
      Returns:
      NATEntry Returns a NATEntry
    • deleteNatEntry

      void deleteNatEntry()
      Information provided by the PKI file:
      
          \brief Remove static nat entry that is set to the asa network object
          
              
    • getNatList

      NATListInterface getNatList()
      Information provided by the PKI file:
      
          \brief Returns dynamic nat entry that is set to the asa network object
          
          \return NatListInterface, value is the nat list interface.
          
              
      Returns:
      NATListInterface Returns a NATListInterface
    • deleteNatList

      void deleteNatList()
      Information provided by the PKI file:
      
          \brief Remove dynamic nat entry that is set to the asa network object
          
              
    • nameifChanged

      void nameifChanged(String newName, String oldName)
      Information provided by the PKI file:
      
          \brief Remove nat entry when the referenced nameif is changed.
          
          \param newName, new nameif
          \param oldName, old nameif
          
              
      Parameters:
      newName - Takes in a parameter of newName
      oldName - Takes in a parameter of oldName
    • getRunningConfig

      List<String> getRunningConfig()
      Information provided by the PKI file:
      
          \brief Returns all object configuration strings in show run.
          
          \return vector<string>, value is all object configuration strings in show run.
          
              
      Returns:
      List<String> Returns a List<String>
    • getNatRunningConfig

      List<String> getNatRunningConfig()
      Information provided by the PKI file:
      
          \brief Returns object + nat configuration strings in show run
          
          \return vector<string>, value object + nat configuration strings in show run
          
              
      Returns:
      List<String> Returns a List<String>
    • getNatStatement

      String getNatStatement()
      Information provided by the PKI file:
      
          \brief Returns the nat statement configuration string in show run.
          
          return string, value is the nat statement configuration string in show run.
          
              
      Returns:
      String Returns a String
    • getAddressStatement

      String getAddressStatement()
      Information provided by the PKI file:
      
          \brief Returns the host address/subnet mask statement configuration string in show run.
          
          \return string, value is the host address/subnet mask statement configuration string in show run.
          
              
      Returns:
      String Returns a String
    • updateAsaAclStatement

      void updateAsaAclStatement()
      Information provided by the PKI file:
      
          \brief Update the corresponding acl statements that have reference to this asa network object